KYC Update

POST /api/v{version}/Kyc/update

Description

This endpoint is used to update the Know Your Customer (KYC) details. The update process involves submitting various pieces of information including the tier level, address verification status, Bank Verification Number (BVN), and KYC ID.

Parameters

• version (string, path, required): The version of the API.
• Accept-Language (string, header, optional): Change the default response message language from English (en). Available languages are fr and en.

Request Body

• Media Type: application/json

Example Value

{
  "tier": 0,
  "addressVerified": true,
  "bvn": "string",
  "kycId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Responses

This section outlines the possible responses from the KYC update API.

Success Response (200)

The Success Response (200) is returned when the KYC details are successfully updated. This response indicates the success of the operation and provides additional details.

Response Fields

Field	Type	Description
succeeded	boolean	Indicates the success of the KYC update request.
message	string	A message indicating the outcome of the operation.
errors	array	An array of strings providing details about any errors encountered.
data	object	Contains the updated KYC details.
data.id	string	The ID of the KYC record.
data.tier	string	The tier level of the KYC record.
data.name	string	The name associated with the KYC record.
data.tenantId	string	The tenant ID associated with the KYC record.
data.ownerId	string	The owner ID associated with the KYC record.
data.approved	boolean	Indicates whether the KYC record is approved.
data.isTenant	boolean	Indicates whether the KYC record is associated with a tenant.
data.isAddressVerified	boolean	Indicates whether the address is verified.
data.approvedOn	string	The date and time when the KYC record was approved (in ISO 8601 format).
data.bvn	string	The Bank Verification Number associated with the KYC record.
data.status	string	The status of the KYC record.

Example Value

{
  "succeeded": true,
  "message": "string",
  "errors": [
    "string"
  ],
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tier": "string",
    "name": "string",
    "tenantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "ownerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "approved": true,
    "isTenant": true,
    "isAddressVerified": true,
    "approvedOn": "2024-08-06T22:14:12.185Z",
    "bvn": "string",
    "status": "string"
  }
}